Inside Macintosh: Macintosh Toolbox Essentials

Previous | Chapter Top | Chapter Contents | Next

Event Masks

Enumerators of type EventMask specify what kind of events you want your application to receive. You use these enumerators with these Event Manager functions: GetNextEvent (GetNextEvent) , WaitNextEvent (WaitNextEvent) , EventAvail (EventAvail) , OSEventAvail (OSEventAvail) , FlushEvents (FlushEvents) , GetOSEvent (GetOSEvent) . To set the system event mask, which determines which low-level events your application receives, you use SetEventMask (SetEventMask) . For information about all these functions, see "Receiving Events" .

typedef UInt16 EventMask;   /* event mask */
enum {
    mDownMask           =   0x0002,     /* mouse-down event (bit 1) */
    mUpMask             =   0x0004,     /* mouse-up event (bit 2) */
    keyDownMask         =   0x0008,     /* key-down event (bit 3) */
    keyUpMask           =   0x0010,     /* key-up event (bit 4) */
    autoKeyMask         =   0x0020,     /* auto-key event (bit 5) */
    updateMask          =   0x0040,     /* update event (bit 6) */
    diskMask            =   0x0080,     /* disk-inserted event (bit 7) */
    activMask           =   0x0100,     /* activate event (bit 8) */
    highLevelEventMask  =   0x0400,     /* high-level event (bit 10) */
    osMask              =   0x0800      /* operating-system event (bit 15) */
    everyEvent          = 0xFFFF        /* every event */   
    /* event message masks for keyboard events */
    charCodeMask        = 0x000000FF,   /* use to get character code */
    keyCodeMask         = 0x0000FF00,   /* use to get key code */
    adbAddrMask         = 0x00FF0000,   /* ADB address if ADB keyboard */
    osEvtMessageMask    = 0xFF000000L   /* can use to extract message code */
};

Enumerator descriptions

mDownMask
The enumerator indicating you want your application to receive a mouse-down event.
mUpMask
The enumerator indicating you want your application to receive a mouse-up event.
keyDownMask
The enumerator indicating you want your application to receive a key-down event.
keyUpMask
The enumerator indicating you want your application to receive a key-up event.
autoKeyMask
The enumerator indicating you want your application to receive an auto-key event.
updateMask
The enumerator indicating you want your application to receive an update event.
diskMask
The enumerator indicating you want your application to receive a disk-inserted event.
activMask
The enumerator indicating you want your application to receive an activate event.
highLevelEventMask
The enumerator indicating you want your application to receive a high-level event.
osMask
The enumerator indicating you want your application to receive an operating-system event
everyEvent
The enumerator indicating you want your application to receive every event.
charCodeMask
The enumerator indicating you want your application to receive a character-code keyboard event.
keyCodeMask
The enumerator indicating you want your application to receive a key-code keyboard event.
adbAddrMask
The enumerator indicating you want your application to receive an ADB address if there is an ADB keyboard.
osEvtMessageMask
The enumerator indicating you want your application to receive a keyboard event that can be used to extract a message code.

© 1997 Apple Computer, Inc.

Previous | Chapter Top | Chapter Contents | Next